vcReserveProductStatement

Reserve Product statement creates a process requirement for a matching product to be available and reserves it for this process. This is a requirement statement and thus can be only added to the Requirements routine of a process routine.

See in: Overview

Module: vcProcessModel

Parent: vcRequirementStatement

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

NameTypeAccessDescription
FiltervcProductFilterRGets the filter.
ProductVariableNameStringRWGets or sets the name of the process variable where to store the reserved product instance

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

NameReturn TypeParametersDescription
demoteFromCombinationFiltervcProductFilterNoneDowngrades back to filter, filter count must have 1 or 0 filters.
See more
Returns:
vcProductFilter: The modified filter.

Exceptions:
TypeError: When the filter is not a CombinationFilter.
TypeError: When CombinationFilter has more than 1 sub-filters.
promoteToCombinationFiltervcProductFilterNoneUpgrades current filter to combination filter.
See more
Returns:
vcProductFilter: The modified filter.

Exceptions:
TypeError: When the filter is already a CombinationFilter.
replaceFromvcProductFiltervcStatement statementSets filter from other container.
See more
Parameters:
statement (vcStatement): The statement to replace the filter from. Has to be a statement with a filter container.

Returns:
vcProductFilter: The modified filter.

Exceptions:
AttributeError: When argument is a statement without a filter container.
setFiltervcProductFiltervcProductFilterType filterTypeSets to specific filter.
See more
Parameters:
filterType (vcProductFilterType): The type of filter to set to.

Returns:
vcProductFilter: The new filter.

Exceptions:
AttributeError: When the argument filterType is ProductType.

Events

Learn how to use events here. The events are also inherited from the parent class.

NameParametersDescription
OnFilterChangedNoneTriggered when filter is changed.